home *** CD-ROM | disk | FTP | other *** search
/ TPUG - Toronto PET Users Group / TPUG Users Group CD / TPUG Users Group CD.iso / MSDOS / (m)aal / PKXARC.DOC < prev    next >
Text File  |  1986-12-14  |  14KB  |  429 lines
  1. PKXARC   FAST!   Archive Extract Utility   Version 3.4  12-15-86   Page 1
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                         Table of Contents
  8.                         -----------------
  9.  
  10.  
  11.  Topic                                                 Page
  12.  -----                                                 ----
  13.  
  14.    Features and Overview .............................. 2
  15.  
  16.    Using PKXARC ....................................... 3
  17.  
  18.    PKXARC Warning Messages............................. 4
  19.  
  20.    PKXARC Error Messages .............................. 4
  21.   
  22.    PKXARC Revision history ............................ 5
  23.  
  24.    Using PKXARC in a batch file ....................... 8
  25.  
  26.    General Information ................................ 9
  27.  
  28.    Software License ................................... 10
  29.  
  30. PKXARC   FAST!   Archive Extract Utility   Version 3.4  12-15-86   Page 2
  31.  
  32.  
  33.  
  34. Features
  35. --------
  36.  
  37.   - THE FASTEST ARCHIVE EXTRACTION - EVER.
  38.  
  39.   - Data integrity ensured by 16 bit Cyclic Redundancy Check.
  40.  
  41.   - Supports the PKARC file squashing and archive comment features.
  42.  
  43.   - Superior file buffering.
  44.  
  45.   - Not copy protected.
  46.  
  47.   - Pay only if you find the software useful.
  48.  
  49.  
  50. Overview
  51. --------
  52.  
  53. An  archive  is  a collection of one or more files collected into a 
  54. single archive file.  A file extension of .ARC is usually  used  to 
  55. denote  an  archive.  Each file in an archive is compressed to save 
  56. disk space, backup storage space, and file transfer time.   When  a 
  57. file  is  archived,  it  is  analyzed  and compressed with the most 
  58. optimal data compression method for that file.  Every  file  in  an 
  59. archive  is  stored  with a 16-bit Cyclic Redundancy Check (CRC) to 
  60. ensure data integrity when the file is extracted from the archive.
  61.  
  62. PKXARC is a FAST! archive extraction utility  that  extracts  files 
  63. from an archive and restores them to their orignal name, size, time 
  64. & date.  It  is  completely  compatible  with  SEAware's  (Software 
  65. Enhancement  Associate's)  ARC  program  and  my  own FAST! archive 
  66. create/update  utility  PKARC,  but  is  many  times  faster   than 
  67. SEAware's  ARC  program  and  faster than ANY OTHER archive extract 
  68. utility.  PKXARC achieves its  speed  through  the  use  of  highly 
  69. optimized  assembly  language  code  and  advanced  file  buffering 
  70. techniques.
  71.  
  72. PKXARC   FAST!   Archive Extract Utility   Version 3.4  12-15-86   Page 3
  73.  
  74.  
  75.  
  76. Using PKXARC
  77. ------------
  78.  
  79. Usage: PKXARC [options] archive [d:path\] [file...]
  80.  
  81. Options are:
  82.  
  83.   /r = replace existing files           /v = verbose listing of archive(s)
  84.   /c = extract file(s) to the console   /p = extract file(s) to the printer
  85.   /t = test archive integrity           /l = display software license
  86.  
  87.   archive  Archive file name, wildcards *,? ok.  Default extension
  88.            is .ARC
  89.   d:path\  Output drive and/or path.
  90.   file     Name(s) of files to extract, list, or test.
  91.            Wildcards *,? ok.  Default is ALL files.
  92.  
  93.  
  94. Examples:
  95.  
  96. PKXARC a:* b:
  97.   - Extract  all  files  from  all  archives  on  drive  A: storing 
  98.     extracted files on drive B:.
  99.  
  100. PKXARC sigdir1 c:
  101.   - Extract all files from the archive SIGDIR1.ARC in  the  current 
  102.     drive & subdirectory storing extracted files on drive C:.
  103.  
  104. PKXARC c:\lotus\tax *.wks
  105.   - Extract  all  .WKS  files from archive C:\LOTUS\TAX.ARC storing 
  106.     extracted files in the current drive & subdirectory.
  107.  
  108. PKXARC/r c:\public\* d:\ *.doc *.txt
  109.   - Extract all .DOC and  .TXT  files  from  all  archives  in  the 
  110.     directory  C:\PUBLIC  storing  the  extracted files in the root 
  111.     directory of drive D:.  Overwrite existing files without query.
  112.  
  113. PKXARC/v c:\download\*
  114.   - Display a verbose listing of  all  archives  in  the  directory 
  115.     C:\DOWNLOAD.
  116.  
  117. PKXARC/c utility *.doc
  118.   - Extract  all .DOC files form the archive UTILITY.ARC displaying 
  119.     extracted files on the console.
  120.  
  121. PKXARC/p utility *.doc
  122.   - Same as above, except extracted  files  are  displayed  on  the 
  123.     printer.
  124.  
  125. PKXARC/t utility
  126.   -Test the integrity of the archive UTILITY.ARC.
  127.  
  128. PKXARC/t c:\download\*
  129.   -Test the validity of all archives in the directory C:\DOWNLOAD.
  130.  
  131. PKXARC   FAST!   Archive Extract Utility   Version 3.4  12-15-86   Page 4
  132.  
  133.  
  134.  
  135. PKXARC warnings
  136. ---------------
  137.  
  138. Warning!  File XXXXXXXX.YYY already exists!  overwrite (y/n)?
  139.   - A file to be extracted from the archive already exists on disk.  
  140.     Answer  "y"  to  extract  the  file from the archive anyway and 
  141.     overwrite the existing file, "n" to not extract the  file  from 
  142.     the archive.  Use the "/r" command line option to suppress this 
  143.     warning.
  144.  
  145. Unknown packing method for: XXXXXXXX.YYY
  146.   - The  file is squeezed or encoded in a unknown way.  The archive 
  147.     is probably corrupt.
  148.  
  149. Warning!  File XXXXXXXX.YYY fails CRC check
  150.   - The Cyclic Redundancy  Check  calculation  did  not  match  the 
  151.     stored value.  The file is probably corrupt.
  152.  
  153. XXXXXXXX.YYY is not an archive
  154.   - The file specified is either not an archive, or is corrupt.
  155.  
  156. Archive length error
  157.   - A end of file token  was  not  found  for  a  file  within  the 
  158.     archive.  The archive is corrupt.
  159.  
  160.  
  161. PKXARC errors
  162. -------------
  163.  
  164. PKXARC: can't find XXXXXXXX.YYY
  165.   - The given archive filename could not be found.
  166.  
  167. PKXARC: cannot read archive: XXXXXXXX.YYY
  168.   - The archive could not be opened.
  169.  
  170. PKXARC: Cannot create: XXXXXXXX.YYY
  171.   - The  output file could not be created.  The output directory is 
  172.     invalid or full.
  173.  
  174. PKXARC: File has invalid decode tree
  175.   - The Huffman decode tree for the file is invalid.   The  archive 
  176.     is corrupt.
  177.  
  178. PKXARC: Disk full
  179.   - The disk is full.
  180.  
  181. PKXARC: Internal table overflow
  182.   - An internal decode table overflowed.  The archive is corrupt.
  183.  
  184. PKXARC   FAST!   Archive Extract Utility   Version 3.4  12-15-86   Page 5
  185.  
  186.  
  187.  
  188. PKXARC history
  189. --------------
  190.  
  191. Soon  after  the archive file format was introduced into the public 
  192. domain, it became popular and many BBS files were  transfered  this 
  193. way.   The  archive format is a convenient way to put several files 
  194. into one and compress them for effecient disk storage  and  reduced 
  195. transfer time, in one step.
  196.  
  197. However, the archive utility was much slower  at  extracting  files 
  198. than  equivalent  UnSQueeze type programs.  In the inevitable quest 
  199. for faster archive file extraction, PKXARC was created.
  200.  
  201.  
  202. Changes in PKXARC version 2.3
  203. -----------------------------
  204.  
  205. The  ability  to extract dynamic Ziv-Lempel-Welch encoded files was 
  206. added.  Version  5.0  of  ARC  introduced  a  new,  more  efficient 
  207. variation  of Ziv-Lempel "Crunching".  PKXARC can now extract files 
  208. Crunched with this method, approximately 3 times  faster  than  ARC 
  209. 5.1.
  210.  
  211.  
  212. Changes in PKXARC version 2.4
  213. -----------------------------
  214.  
  215. Performance  for  extracting  dynamic  Ziv-Lempel  files  has  been 
  216. improved. Files which are identified as "Crunched" (with a  capital 
  217. C) on the ARC verbose listing extract 15-20% faster than before.
  218.  
  219. When  a  "Disk  full"  error  occurred, previous versions of PKXARC 
  220. would leave an empty or incomplete file on the  disk.   PKXARC  now 
  221. deletes  any  incomplete  files  before aborting with a "Disk full" 
  222. error.
  223.  
  224.  
  225. Changes in PKXARC version 2.5
  226. -----------------------------
  227.  
  228. The ability to extract specific files was added.  PKXARC can now be 
  229. passed  the specific names of files to be extracted from an archive 
  230. on the command line.
  231.  
  232. PKXARC   FAST!   Archive Extract Utility   Version 3.4  12-15-86   Page 6
  233.  
  234.  
  235.  
  236. Changes in PKXARC version 2.6
  237. -----------------------------
  238.  
  239. Extraction  performance  for  all  compression   types   has   been 
  240. significantly  improved  over  PKXARC  version 2.5.  Files that are 
  241. crunched with older versions of ARC (pre 5.x)  extract  5%  faster.  
  242. Squeezed  files  extract  15% faster.  Files that are Crunched with 
  243. ARC 5.x extract 20% faster.
  244.  
  245.  
  246. Changes in PKXARC version 2.7
  247. -----------------------------
  248.  
  249. Extraction performance of Squeezed files  has  been  improved  more 
  250. than  60%. PKXARC version 2.7 can extract a Squeezed file more than 
  251. 8 times as fast as ARC 5.1.
  252.  
  253. The message displayed when a  file  is  being  extracted  has  been 
  254. enhanced to indicate the compression method used to store the file.
  255.  
  256. Message                 Meaning
  257. -------                 -------
  258. Extracting   The file was Stored.
  259. un-Packing   The file was Packed with non-repeat packing.
  260. uncrunching  The file was crunched with old style Ziv-Lempel-Welch compression.
  261. unSqueezing  The file was Squeezed with Huffman encoding.
  262. unCrunching  The file was Crunched with Dynamic Ziv-Lempel-Welch compression.
  263. unSquashing  The file was Squashed with Dynamic Ziv-Lempel-Welch compression.
  264.  
  265.  
  266. Changes in PKXARC version 3.0
  267. -----------------------------
  268.  
  269. The following functions have been added to PKXARC version 3.0:
  270.  
  271. Extraction of files to the console or printer.
  272. The ability to display a verbose archive listing.
  273.  
  274. PKXARC   FAST!   Archive Extract Utility   Version 3.4  12-15-86   Page 7
  275.  
  276.  
  277.  
  278. Changes in PKXARC version 3.1
  279. -----------------------------
  280.  
  281. A  minor  bug  in  the  pattern  matching  code for individual file 
  282. specifications when using the wildcard "*" was fixed.  For example, 
  283. previous versions of PKXARC would not correctly match "flight*.com" 
  284. to the exact filename "flight.com".  This  has  been  corrected  in 
  285. PKXARC version 3.1.
  286.  
  287. The  verbose archive listing now displays the total number of files 
  288. in the archive.
  289.  
  290. Extraction speed has been increased  5-10%  for  all  decompression 
  291. methods.
  292.  
  293. A  "jr"  version  of  PKXARC was created for computers with limited 
  294. memory.  PKXARCjr requires only 74K of free memory to run,  but  is 
  295. slightly  slower than the standard version for most archives.  Both 
  296. versions will run on  any  type  of  computer  providing  there  is 
  297. sufficient free memory.
  298.  
  299.  
  300. Changes in PKXARC version 3.2
  301. -----------------------------
  302.  
  303. The  archive test function "/t" was added to PKXARC.  This function 
  304. tests the integrity of the archive without extracting the files  to 
  305. disk.  Specifically, the CRC for each file is computed and compared 
  306. against the correct value stored in the archive.
  307.  
  308. Extraction speed has been increased by 5% for most files.
  309.  
  310.  
  311. Changes in PKXARC version 3.3
  312. -----------------------------
  313.  
  314. Support of the PKARC archive comment  feature  was  added.   PKXARC 
  315. will  automatically  display an archive comment if it is present in 
  316. an archive.
  317.  
  318. When extracting files to the  printer,  PKXARC  will  now  print  a 
  319. form-feed character after each file.
  320.  
  321. Extraction speed has been increased by 5% for Crunched files.
  322.  
  323.  
  324. PKXARC   FAST!   Archive Extract Utility   Version 3.4  12-15-86   Page 8
  325.  
  326.  
  327.  
  328. Changes in PKXARC version 3.4
  329. -----------------------------
  330.  
  331. Support of "squashed" files created by PKARC 2.0  has  been  added.  
  332. Squashing is a variation of Dynamic Ziv-Lempel-Welch encoding which 
  333. can yield a 10% or better compression ratio for large  text  files.  
  334. Squashed  files  typically  unsquash  15%  faster  than  equivalent 
  335. crunched files.
  336.  
  337. In order to be consistent with the command  syntax  of  PKARC,  the 
  338. requirement  for dashes "-" to be given before individual filenames 
  339. to extract or list has been removed.
  340.  
  341. Error  recovery  for  damaged archives has been improved.  Previous 
  342. versions of PKXARC would  occasionally  hang  up  while  processing 
  343. damaged  archives.   PKXARC version 3.4 has improved error recovery 
  344. allowing at least the partial extraction of files  from  a  damaged 
  345. archive.
  346.  
  347.  
  348. Using PKXARC in a batch file
  349. ---------------------------
  350.  
  351. If you are using PKXARC from a batch file, you can test  if  PKXARC 
  352. aborted  with  an  error using the DOS errorlevel variable.  PKXARC 
  353. returns a non-zero errorlevel if an  error  occurred,  and  a  zero 
  354. errorlevel for normal termination.
  355.  
  356. PKXARC   FAST!   Archive Extract Utility   Version 3.4  12-15-86   Page 9
  357.  
  358.  
  359.  
  360. General Information
  361. -------------------
  362.  
  363. PKXARC will run on any IBM  PC/XT/AT/RT/jr/Portable/Convertible  or 
  364. DOS  compatible  whatever  running  PC/MS-DOS  2.0 or higher with a 
  365. minimum of 128K free RAM.
  366.  
  367. IBM is a registered trademark of the International Business Machine
  368. Corporation.
  369. MS-DOS is a registered trademark of Microsoft Inc.
  370.  
  371.  
  372. If you have any questions or comments about PKARC send them to Phil 
  373. Katz at:
  374.  
  375. Exec-PC multi-user IBM BBS, Bob Mahoney SYSOP
  376. Shorewood, Wisconsin
  377. 414-964-5160
  378. 300/1200/2400 baud, 24 hours a day, 16 lines
  379.  
  380. or
  381.  
  382. RBBS-PC of FARGO, Loren Jones SYSOP
  383. Fargo, North Dakota
  384. 701-293-5973
  385. 300/1200/2400 baud, 24 hours a day
  386.  
  387.  
  388. Special thanks to Bob Mahoney, Alan Losoff, Gene Alm,
  389. Loren Jones, and Mike Shawaluk.
  390.  
  391.  
  392. PKXARC   FAST!   Archive Extract Utility   Version 3.4  12-15-86   Page 10
  393.  
  394.  
  395.  
  396. License
  397. -------
  398.  
  399. Copyright (c) 1986 PKWARE, Inc.  All Rights Reserved.
  400.  
  401. You are free to use, copy and distribute PKXARC providing that:
  402.  
  403.         NO FEE IS CHARGED FOR USE, COPYING OR DISTRIBUTION.
  404.  
  405.         IT IS NOT MODIFIED IN ANY WAY.
  406.  
  407. Clubs  and  user  groups  may charge a nominal fee for expenses and 
  408. handling while distributing PKARC.
  409.  
  410. Site licenses, commercial licenses and custom versions of PKARC and 
  411. PKXARC  are  available.   Write  to  the  address  below  for  more 
  412. information.
  413.  
  414. This program is provided AS IS without any warranty,  expressed  or 
  415. implied,  including  but  not  limited  to fitness for a particular 
  416. purpose.
  417.  
  418. If  you  find  PKXARC  fast,  easy,  and  convenient  to   use,   a 
  419. contribution  of  $20 would be appreciated.  With each contribution 
  420. of $45 or more you will be registered to receive  a  diskette  with 
  421. the  next version of PKARC and PKXARC when available.  Please state 
  422. the current versions of PKARC  and  PKXARC  that  you  have.   Send 
  423. contributions to:
  424.  
  425. PKWARE, Inc.
  426. 7032 Ardara Avenue
  427. Glendale, WI 53209
  428.  
  429.